/*
 * Copyright 2007 The Apache Software Foundation Licensed under the Apache
 * License, Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law
 * or agreed to in writing, software distributed under the License is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

package org.apache.ibatis.ibator.config;

import java.util.List;

import org.apache.ibatis.ibator.api.dom.xml.Attribute;
import org.apache.ibatis.ibator.api.dom.xml.XmlElement;
import org.apache.ibatis.ibator.internal.util.StringUtility;
import org.apache.ibatis.ibator.internal.util.messages.Messages;

/**
 * This class is used to specify a renaming rule for columns in a table. This
 * renaming rule will be run against all column names before calculating the
 * corresponding property name. The most common use case is when columns in a
 * table are all prefixed by a certain value. For example, if columns in a table
 * are named:
 * <ul>
 * <li>CUST_NAME</li>
 * <li>CUST_ADDRESS</li>
 * <li>CUST_CITY</li>
 * <li>CUST_STATE</li>
 * </ul>
 * it might be annoying to have the generated properties all containing the CUST
 * prefix. This class can be used to remove the prefix by specifying
 * <ul>
 * <li>searchString = "^CUST"</li>
 * <li>replaceString=""</li>
 * </ul>
 * Note that internally, Ibator uses the
 * <code>java.util.regex.Matcher.replaceAll</code> method for this function. See
 * the documentation of that method for example of the regular expression
 * language used in Java.
 * 
 * @author Jeff Butler
 */
public class ColumnRenamingRule
{
	private String searchString;
	private String replaceString;

	public String getReplaceString()
	{
		return replaceString;
	}

	public void setReplaceString(String replaceString)
	{
		this.replaceString = replaceString;
	}

	public String getSearchString()
	{
		return searchString;
	}

	public void setSearchString(String searchString)
	{
		this.searchString = searchString;
	}

	public void validate(List<String> errors, String tableName)
	{
		if (!StringUtility.stringHasValue(searchString))
		{
			errors.add(Messages.getString("ValidationError.14", tableName)); //$NON-NLS-1$
		}
	}

	public XmlElement toXmlElement()
	{
		XmlElement xmlElement = new XmlElement("columnRenamingRule"); //$NON-NLS-1$
		xmlElement.addAttribute(new Attribute("searchString", searchString)); //$NON-NLS-1$

		if (replaceString != null)
		{
			xmlElement.addAttribute(new Attribute(
					"replaceString", replaceString)); //$NON-NLS-1$
		}

		return xmlElement;
	}
}
